4.5 查询外部用户详情(支持根据name查询)

基本信息

Path: /api/v1/externalUser/queryUser

Method: GET

接口描述:

请求参数

Query

注意: 1. 各个样例之间为并列关系, 实际发送请求时只需参照其中某一个即可

根据id查询

参数名称 类型 是否必须 示例 备注
id string 必须 外部用户ID

根据name查询

参数名称 类型 是否必须 示例 备注
name string 必须 外部用户名
userDirectoryId string 与userDirectoryName二选一 所属用户目录ID,ID和名称只需传一个即可,都传时以ID为准
userDirectoryName string 与userDirectoryId二选一 所属用户目录名称,ID和名称只需传一个即可,都传时以ID为准

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 返回码,0 返回成功
data object 必须 报文数据主体
├─ data object[] 必须 数据
├─├─ id string 必须 用户ID
├─├─ displayName string 必须 显示名
├─├─ externalId string 必须 外部ID
├─├─ name string 必须 名称
├─├─ path string 必须 所属组织架构
├─├─ status number 必须 启用状态:0禁用,1启用
├─├─ phone string 必须 手机号码
├─├─ email string 必须 电子邮件
├─├─ expiredTime string 必须 过期时间,时间戳,13位长度,单位毫秒,'0'表示永不过期
├─├─ description string 必须 描述
├─├─ ext object 必须 扩展字段
├─├─├─fieldDataSource object 必须 认证时用户数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段
├─├─├─├─displayName string 必须 显示名数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─├─├─description string 必须 描述数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─├─├─email string 必须 电子邮件数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─├─├─expiredTime string 必须 过期时间数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─├─├─path string 必须 所属组织架构数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─├─├─phone string 必须 手机号码数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─├─├─status string 必须 启用状态数据来源,'local'认证时从本地获取该字段,'server'认证时从认证服务器获取该字段,默认从用户目录对应服务器获取该字段
├─├─ authComposeId string 必须 认证策略ID
├─├─ authComposeName string 必须 认证策略名称
├─├─ authCompose string 必须 认证策略
├─├─├─ id string 必须 策略id
├─├─├─ name string 必须 策略名称
├─├─ inheritGroup string 必须 继承组织架构 1为继承,0为不继承
├─├─ inheritBand string 必须 继承群组 1为继承,0为不继承
├─├─ userPolicy object 必须 用户策略
├─├─├─ id string 必须 策略id
├─├─├─ name string 必须 策略名称
├─├─ bandList object[] 必须 群组列表
├─├─├─ id string 必须 群组id
├─├─├─ name string 必须 群组名称
├─├─├─ description string 必须 群组描述
├─├─ isDeleted number 必须 外部已删除:0未删除,1已删除  

返回示例

{
    "code": 0,
    "data": {
        "data": [
            {
                "id": "238eb5e0-4f08-11eb-a22f-4f6c72112dad",
                "authComposeId": "a84ebf70-0ed8-11eb-abd5-850e8cafdb99",
                "name": "EXUSER",
                "path": "/",
                "status": 1,
                "phone": "",
                "email": "",
                "expiredTime": "1609862399000",
                "description": "",
                "ext": {
                    "fieldDataSource": {
                        "status": "local",
                        "path": "local",
                        "phone": "local",
                        "email": "local",
                        "expiredTime": "local",
                        "description": "local",
                        "label": "local"
                    }
                },
                "authComposeName": "默认策略",
                "authCompose": {
                    "id": "a84ebf70-0ed8-11eb-abd5-850e8cafdb99",
                    "name": "默认策略"
                },
                "bandList": [
                {
                    "id": "54f643f0-5717-11eb-b6e0-f7651d8dccc0",
                    "name": "band1",
                    "description": ""
                },
                {
                    "id": "64f643f0-5717-11eb-b6e0-f7651d8dccc0",
                    "name": "band2",
                    "description": ""
                }
            ],
                "inheritGroup": 1,
                "inheritBand": 1,
                "userPolicy": {
                    "id": "default",
                    "name": "默认策略"
                },
                "isDeleted": 0
            }
        ]
    },
    "msg": "请求成功"
}

错误信息

错误提示 错误码
参数检查出错 10000001
用户目录不存在 77200001
用户不存在 77200004
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""